<?php
/**
 * Created by PhpStorm.
 * User: shutao
 * Date: 2018/9/25
 * Time: 14:24
 */

namespace wechat\hook;

/**
 * 监听的事件
 * ```
 * $wMessage = new WeChatMessage($message);
 * if ($responseData = HookHelp::on('wechat_' . $wMessage->msgType, $wMessage)) {
 *      return $responseData;
 * }
 * ```
 */
class WechatOn
{
    /**
     * 事件消息，可以通过 $wMessage->event 来判断具体接收到的事件
     * ```
     * subscribe 用户未关注时，进行关注后的事件推送
     * unsubscribe 取消订阅
     * scan 扫描带参数二维码事件
     * location 上报地理位置事件
     * click 自定义菜单事件
     * view 点击菜单中的链接
     * ```
     */
    const EVENT = 'wechat_event';
    /**
     * 文字消息
     */
    const TEXT = 'wechat_text';
    /**
     * 图片消息
     */
    const IMAGE = 'wechat_image';
    /**
     * 语音消息
     */
    const VOICE = 'wechat_voice';
    /**
     * 坐标消息
     */
    const LOCATION = 'wechat_location';
    /**
     * 链接消息
     */
    const LINK = 'wechat_link';
    /**
     * 文件消息
     */
    const FILE = 'wechat_file';
    /**
     * 小视频
     */
    const SHORTVIDEO = 'wechat_shortvideo';

    // ---------------- 自定义的事件 -------------------
    /**
     * 在授权成功并获取到用户信息之后
     */
    const SNSAPI_USERINOF_SUCCESS = 'snsapi_userinfo_success';
    /**
     * 在微信授权成功之后
     */
    const FINISH_WECHAT_AUTH = 'finish_wechat_auth';
}